-
Notifications
You must be signed in to change notification settings - Fork 129
Update chaos engg docs with recent product changes #1256
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-1256.surge.sh 🎊 |
f16d14e
to
9334864
Compare
fa2f697
to
56df276
Compare
56c9016
to
fc856bc
Compare
e4ab07a
to
4519237
Compare
- `POST`: Add new configuration | ||
- `PATCH`: Add a rule |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is a configuration and what is a rule?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have defined this on line 46:
Service faults can be configured using the endpoint at
/_localstack/chaos/faults
.
The configuration schema consists of an array of one or more rules, where each rule specifies the conditions for the fault to occur.
When active, rules are evaluated sequentially on every request to LocalStack until the first match.
Is it unclear?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah, now I see that the payload accepts an array. so this array would be the configuration
and each element a rule
?
that would mean that a configuration is identified by an id
, and GET ./chaos/faults
would return the configs with their ids? To update a configuration I'd then PATCH ./chaos/faults/<configuration_id>
similarly for the rules
there is a DELETE
so I'd assume they are also identified by an id DELETE ./chaos/faults/<fault_id>/<rule_id>
but maybe I'm thinking to complicated here... 🤔 having all that auto generated with make things much easier :D
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is just one configuration. Multiple configurations are not supported.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, then I guess just needs to be updated
GET: Get current configuration
POST: Add new configuration
PATCH: Add a rule
DELETE: Delete a rule
maybe a GET and PUT is sufficient here then. instead of the term 'configuration' just 'list of rules' might be easier to understand.
9fb4e99
to
bb9cb25
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
briefly went through changes and comments since my last review. It's a good first step and to be extended in the near future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM overall. left 2 comments, but i think the label/tag one is more important.
Caution
Reviewers please do not merge
Background
Following product changes are planned for the LocalStack Chaos Engineering tool suite:
FIS
Outages Extension
Chaos Plugin
Changes
TODO